spin button: Document sizing peculiarities
authorMatthias Clasen <mclasen@redhat.com>
Thu, 28 Jan 2016 04:30:25 +0000 (23:30 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 28 Jan 2016 04:30:25 +0000 (23:30 -0500)
Document that it is best to explicitly set width-chars and
max-width-chars to avoid surprises.

https://bugzilla.gnome.org/show_bug.cgi?id=727294

gtk/gtkspinbutton.c

index 27f518401844ed41f74f70918f307e650fdc6bf9..7961dc9fca8c2362dde01f8452f95f9e1f16bbb2 100644 (file)
  *
  * The main properties of a GtkSpinButton are through an adjustment.
  * See the #GtkAdjustment section for more details about an adjustment's
- * properties.
+ * properties. Note that GtkSpinButton will by default make its entry
+ * large enough to accomodate the lower and upper bounds of the adjustment,
+ * which can lead to surprising results. Best practice is to set both
+ * the #GtkEntry::width-chars and #GtkEntry::max-width-chars poperties
+ * to the desired number of characters to display in the entry.
  *
  * # CSS nodes
  *